Back

Commercial Variable Recurring Payments Specification

OBIE VRP Profile 
 3.1.10 
OAS3

https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA

VRP OpenAPI Specification

Servers

Domestic VRP Consents

POST​/domestic-vrp-consents
Create a domestic VRP consent

Create a domestic VRP consent

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

Examples: 
{
  "Data": {
    "ReadRefundAccount": "No",
    "ControlParameters": {
      "ValidFromDateTime": "2023-09-04T16:20:50.902Z",
      "ValidToDateTime": "2023-09-05T16:20:50.902Z",
      "InitialPayment": {
        "Amount": "100",
        "Currency": "GBP"
      },
      "VRPType": [
        "UK.OBIE.VRPType.Other"
      ],
      "VRPSubType": [
        "UK.NWG.VRPSubType.Single"
      ],
      "PSUAuthenticationMethods": [
        "UK.OBIE.SCANotRequired"
      ]
    },
    "Initiation": {
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "83060821231587",
        "Name": "ACME Ltd",
        "MerchantName": "ACME Ltd"
      },
      "RemittanceInformation": {
        "Unstructured": "UNSTRUCTURED",
        "Reference": "3d1088cd-5eab-450f"
      }
    }
  },
  "Risk": {}
}

Responses

Code Description Links
201

Default response

Media type
Controls Accept header.
Examples 
{
  "Data": {
    "ReadRefundAccount": "No",
    "ConsentId": "b770a2464f5041cc86b0b30fc8615b45",
    "CreationDateTime": "2023-07-21T11:09:46.233Z",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2023-07-21T11:09:46.233Z",
    "ControlParameters": {
      "ValidFromDateTime": "2023-07-21T12:09:44.789+01:00",
      "ValidToDateTime": "2023-07-22T11:09:44.789Z",
      "InitialPayment": {
        "Amount": "100",
        "Currency": "GBP"
      },
      "VRPType": [
        "UK.OBIE.VRPType.Other"
      ],
      "VRPSubType": [
        "UK.NWG.VRPSubType.Single"
      ],
      "PSUAuthenticationMethods": [
        "UK.OBIE.SCANotRequired"
      ]
    },
    "Initiation": {
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "83060821231587",
        "Name": "ACME Ltd"
      },
      "RemittanceInformation": {
        "Unstructured": "UNSTRUCTURED",
        "Reference": "b89ffd31-947a-4f44"
      }
    }
  },
  "Risk": {
    "ContractPresentInidicator": false,
    "BeneficiaryPrepopulatedIndicator": false
  },
  "Links": {
    "Self": "https://api.rbs.co.uk/open-banking/v3.1/pisp/domestic-vrp-consents/b770a2464f5041cc86b0b30fc8615b45"
  },
  "Meta": {}
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-vrp-consents​/{ConsentId}
Retrieve a domestic VRP consent

Retrieve a domestic VRP consent

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Default response

Media type
Controls Accept header.
Examples 
{
  "Data": {
    "ReadRefundAccount": "No",
    "ConsentId": "b770a2464f5041cc86b0b30fc8615b45",
    "CreationDateTime": "2023-07-21T11:09:46.233Z",
    "Status": "AwaitingAuthorisation",
    "StatusUpdateDateTime": "2023-07-21T11:09:46.233Z",
    "ControlParameters": {
      "ValidFromDateTime": "2023-07-21T12:09:44.789+01:00",
      "ValidToDateTime": "2023-07-22T11:09:44.789Z",
      "InitialPayment": {
        "Amount": "100",
        "Currency": "GBP"
      },
      "VRPType": [
        "UK.OBIE.VRPType.Other"
      ],
      "VRPSubType": [
        "UK.NWG.VRPSubType.Single"
      ],
      "PSUAuthenticationMethods": [
        "UK.OBIE.SCANotRequired"
      ]
    },
    "Initiation": {
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "83060821231587",
        "Name": "ACME Ltd"
      },
      "RemittanceInformation": {
        "Unstructured": "UNSTRUCTURED",
        "Reference": "b89ffd31-947a-4f44"
      }
    }
  },
  "Risk": {
    "ContractPresentInidicator": false,
    "BeneficiaryPrepopulatedIndicator": false
  },
  "Links": {
    "Self": "https://api.rbs.co.uk/open-banking/v3.1/pisp/domestic-vrp-consents/b770a2464f5041cc86b0b30fc8615b45"
  },
  "Meta": {}
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
DELETE​/domestic-vrp-consents​/{ConsentId}
Delete a domestic VRP

Delete a domestic VRP

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
204

delete successful

No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
POST​/domestic-vrp-consents​/{ConsentId}​/funds-confirmation
Confirm availability of funds for a VRP

Confirm availability of funds for a VRP

Parameters

Name Description
ConsentId *
string
(path)

ConsentId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "Reference": "string",
    "InstructedAmount": {
      "Amount": "string",
      "Currency": "GBP"
    }
  }
}

Responses

Code Description Links
200

Default response

Media type
Controls Accept header. 
{
  "Data": {
    "FundsConfirmationId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:49:57.234Z",
    "Reference": "string",
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2025-06-17T07:49:57.234Z",
      "FundsAvailable": "Available"
    },
    "InstructedAmount": {
      "Amount": "string",
      "Currency": "GBP"
    }
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
201

Default response

Media type 
{
  "Data": {
    "FundsConfirmationId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:49:57.237Z",
    "Reference": "string",
    "FundsAvailableResult": {
      "FundsAvailableDateTime": "2025-06-17T07:49:57.237Z",
      "FundsAvailable": "Available"
    },
    "InstructedAmount": {
      "Amount": "string",
      "Currency": "GBP"
    }
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

Domestic VRPs

POST​/domestic-vrps
Create a domestic VRP

Create a domestic VRP

Parameters

Name Description
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-jws-signature *
string
(header)

A detached JWS signature of the body of the payload.

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

x-idempotency-key *
string
(header)

Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours.

Request body

Default

{
  "Data": {
    "ConsentId": "string",
    "PSUAuthenticationMethod": "UK.OBIE.SCA",
    "PSUInteractionType": "InSession",
    "Initiation": {
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "ACE Ltd",
        "SecondaryIdentification": "secondary-identif"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "secondary-identif",
        "MerchantName": "ACME Ltd"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "GB",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "UNSTRUCTURED",
        "Reference": "string"
      }
    },
    "Instruction": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "LocalInstrument": "UK.OBIE.BACS",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "GBP"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "GB",
        "AddressLine": [
          "string"
        ]
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "secondary-identif",
        "MerchantName": "ACME Ltd"
      },
      "SupplementaryData": {}
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentInidicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "stri",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "GB"
    }
  }
}

Responses

Code Description Links
201

Default response

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticVRPId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:49:57.282Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusReason": "UK.OBIE.ExemptionNotApplied",
    "StatusReasonDescription": "string",
    "StatusUpdateDateTime": "2025-06-17T07:49:57.282Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:49:57.282Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:49:57.282Z",
    "Refund": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "string",
      "Name": "ACE Ltd",
      "SecondaryIdentification": "secondary-identif"
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "UK.OBIE.CHAPSOut",
        "Amount": {
          "Amount": "string",
          "Currency": "GBP"
        }
      }
    ],
    "Initiation": {
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "ACE Ltd",
        "SecondaryIdentification": "secondary-identif"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "secondary-identif",
        "MerchantName": "ACME Ltd"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "GB",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "UNSTRUCTURED",
        "Reference": "string"
      }
    },
    "Instruction": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "LocalInstrument": "UK.OBIE.BACS",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "GBP"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "GB",
        "AddressLine": [
          "string"
        ]
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "secondary-identif",
        "MerchantName": "ACME Ltd"
      },
      "SupplementaryData": {}
    },
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "string",
      "Name": "ACE Ltd",
      "SecondaryIdentification": "secondary-identif"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentInidicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "stri",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "GB"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {}
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
409

Conflict

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-vrps​/{DomesticVRPId}
Retrieve a domestic VRP

Retrieve a domestic VRP

Parameters

Name Description
DomesticVRPId *
string
(path)

DomesticVRPId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Default response

Media type
Controls Accept header. 
{
  "Data": {
    "DomesticVRPId": "string",
    "ConsentId": "string",
    "CreationDateTime": "2025-06-17T07:49:57.313Z",
    "Status": "AcceptedCreditSettlementCompleted",
    "StatusReason": "UK.OBIE.ExemptionNotApplied",
    "StatusReasonDescription": "string",
    "StatusUpdateDateTime": "2025-06-17T07:49:57.313Z",
    "ExpectedExecutionDateTime": "2025-06-17T07:49:57.313Z",
    "ExpectedSettlementDateTime": "2025-06-17T07:49:57.313Z",
    "Refund": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "string",
      "Name": "ACE Ltd",
      "SecondaryIdentification": "secondary-identif"
    },
    "Charges": [
      {
        "ChargeBearer": "BorneByCreditor",
        "Type": "UK.OBIE.CHAPSOut",
        "Amount": {
          "Amount": "string",
          "Currency": "GBP"
        }
      }
    ],
    "Initiation": {
      "DebtorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "ACE Ltd",
        "SecondaryIdentification": "secondary-identif"
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "secondary-identif",
        "MerchantName": "ACME Ltd"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "GB",
        "AddressLine": [
          "string"
        ]
      },
      "RemittanceInformation": {
        "Unstructured": "UNSTRUCTURED",
        "Reference": "string"
      }
    },
    "Instruction": {
      "InstructionIdentification": "string",
      "EndToEndIdentification": "string",
      "RemittanceInformation": {
        "Unstructured": "string",
        "Reference": "string"
      },
      "LocalInstrument": "UK.OBIE.BACS",
      "InstructedAmount": {
        "Amount": "string",
        "Currency": "GBP"
      },
      "CreditorPostalAddress": {
        "AddressType": "Business",
        "Department": "string",
        "SubDepartment": "string",
        "StreetName": "string",
        "BuildingNumber": "string",
        "PostCode": "string",
        "TownName": "string",
        "CountrySubDivision": "string",
        "Country": "GB",
        "AddressLine": [
          "string"
        ]
      },
      "CreditorAccount": {
        "SchemeName": "UK.OBIE.SortCodeAccountNumber",
        "Identification": "string",
        "Name": "string",
        "SecondaryIdentification": "secondary-identif",
        "MerchantName": "ACME Ltd"
      },
      "SupplementaryData": {}
    },
    "DebtorAccount": {
      "SchemeName": "UK.OBIE.SortCodeAccountNumber",
      "Identification": "string",
      "Name": "ACE Ltd",
      "SecondaryIdentification": "secondary-identif"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillingGoodsAndServicesInAdvance",
    "MerchantCategoryCode": "stri",
    "MerchantCustomerIdentification": "string",
    "ContractPresentInidicator": true,
    "BeneficiaryPrepopulatedIndicator": true,
    "PaymentPurposeCode": "stri",
    "BeneficiaryAccountType": "Business",
    "DeliveryAddress": {
      "AddressLine": [
        "string"
      ],
      "StreetName": "string",
      "BuildingNumber": "string",
      "PostCode": "string",
      "TownName": "string",
      "CountrySubDivision": "string",
      "Country": "GB"
    }
  },
  "Links": {
    "Self": "string",
    "First": "string",
    "Prev": "string",
    "Next": "string",
    "Last": "string"
  },
  "Meta": {}
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
GET​/domestic-vrps​/{DomesticVRPId}​/payment-details
Retrieve a domestic VRP

Retrieve a domestic VRP

Parameters

Name Description
DomesticVRPId *
string
(path)

DomesticVRPId
x-fapi-auth-date
string
(header)

The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

x-fapi-customer-ip-address
string
(header)

The PSU's IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-id
string
(header)

An RFC4122 UID used as a correlation id.

Authorization *
string
(header)

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agent
string
(header)

Indicates the user-agent that the PSU is using.

Responses

Code Description Links
200

Default response

Media type
Controls Accept header. 
{
  "Data": {
    "PaymentStatus": [
      {
        "PaymentTransactionId": "string",
        "Status": "Accepted",
        "StatusUpdateDateTime": "2025-06-17T07:49:57.342Z",
        "StatusDetail": {
          "LocalInstrument": "UK.OBIE.BACS",
          "Status": "string",
          "StatusReason": "Cancelled",
          "StatusReasonDescription": "string"
        }
      }
    ]
  }
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
400

Bad request

Media type
Examples 
{
  "Code": "400 BadRequest",
  "Id": "70bf46a3-03da-473a-ad41-04e72dd2ec91",
  "Message": "Request error found.",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Resource.InvalidConsentStatus",
      "Message": "Consent 607d97c1079842159a931fd82411d03b has been revoked."
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
401

Unauthorized

Media type
Examples 
{
  "status": 401,
  "title": "Unauthorized",
  "description": "Expired Token."
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
403

Forbidden

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links
405

Method Not Allowed

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
406

Not Acceptable

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
415

Unsupported Media Type

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
429

Too Many Requests

Headers:

Name Description Type
Retry-After

Number in seconds to wait

integer
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
No links
500

Internal Server Error

Media type 
{
  "Code": "string",
  "Id": "string",
  "Message": "string",
  "Errors": [
    {
      "ErrorCode": "UK.OBIE.Field.Expected",
      "Message": "string",
      "Path": "string",
      "Url": "string"
    }
  ]
}

Headers:

Name Description Type
x-fapi-interaction-id

An RFC4122 UID used as a correlation id.

string
x-jws-signature

Header containing a detached JWS signature of the body of the payload.

string
No links

Schemas

OBError1{
ErrorCode* string

Low level textual error code, e.g., UK.OBIE.Field.Missing

Enum:
Array [ 29 ]
Message* string
minLength: 1
maxLength: 500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path string
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
minProperties: 1
OBErrorResponse1{
description:

An array of detail error codes, and messages, and URLs to documentation to help remediation.

Code* string
minLength: 1
maxLength: 40

High level textual error code, to help categorize the errors.

Id string
minLength: 1
maxLength: 40

A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.

Message* string
minLength: 1
maxLength: 500

Brief Error message, e.g., 'There is something wrong with the request parameters provided'

Errors* [
minItems: 1
https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBError1OBError1{
ErrorCode* string

Low level textual error code, e.g., UK.OBIE.Field.Missing

Enum:
[ UK.OBIE.Field.Expected, UK.OBIE.Field.Invalid, UK.OBIE.Field.InvalidDate, UK.OBIE.Field.Missing, UK.OBIE.Field.Unexpected, UK.OBIE.Header.Invalid, UK.OBIE.Header.Missing, UK.OBIE.Reauthenticate, UK.OBIE.Resource.ConsentMismatch, UK.OBIE.Resource.InvalidConsentStatus, UK.OBIE.Resource.InvalidFormat, UK.OBIE.Resource.NotFound, UK.OBIE.Rules.AfterCutOffDateTime, UK.OBIE.Rules.DuplicateReference, UK.OBIE.Rules.FailsControlParameters, UK.OBIE.Signature.Invalid, UK.OBIE.Signature.InvalidClaim, UK.OBIE.Signature.Malformed, UK.OBIE.Signature.Missing, UK.OBIE.Signature.MissingClaim, UK.OBIE.Signature.Unexpected, UK.OBIE.UnexpectedError, UK.OBIE.Unsupported.AccountIdentifier, UK.OBIE.Unsupported.AccountSecondaryIdentifier, UK.OBIE.Unsupported.Currency, UK.OBIE.Unsupported.Frequency, UK.OBIE.Unsupported.LocalInstrument, UK.OBIE.Unsupported.Scheme, UK.OBIE.Rules.ResourceAlreadyExists ]
Message* string
minLength: 1
maxLength: 500

A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field

Path string
minLength: 1
maxLength: 500

Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency

Url string

URL to help remediate the problem, or provide more information, or to API Reference, or help etc

}
minProperties: 1]
}
OBDomesticVRPConsentResponse{
Data* {
ReadRefundAccount string

Indicates whether information about RefundAccount should be included in the payment response.

Enum:
Array [ 2 ]
ConsentId* string
minLength: 1
maxLength: 128

Unique identification as assigned by the ASPSP to uniquely identify the consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created.

Status* string

Specifies the status of resource in code form.

Enum:
[ Authorised, AwaitingAuthorisation, Rejected, AcceptedSettlementInProcess ]
StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated.

ControlParameters* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPControlParametersOBDomesticVRPControlParameters{
ValidFromDateTime string($date-time)

^ Start date time for which the consent remains valid.

ValidToDateTime string($date-time)

^ End date time for which the consent remains valid.

InitialPayment https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
MaximumIndividualAmount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
MaximumCumulativeAmount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
MaximumCumulativeNumberOfPayments integer

^ The maximum number of payments that can be made over the entire life of the VRP consent

PeriodicLimits [
minItems: 1
{
PeriodType* string

^ Period type for this period limit

Enum:
[ Day, Week, Fortnight, Month, Half-year, Year ]
PeriodAlignment* string

^ Specifies whether the period starts on the date of consent creation or lines up with a calendar

Enum:
[ Consent, Calendar ]
Amount OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

NumberOfPayments integer

^ The number of payments that can be made under this consent in the period specified

}]
PeriodicPayments [
minItems: 1

This parameter is only valid for Subscription based Journey, when VRP Subtype is selected as UK.NWB.VRPSubType.subscription .

{
PeriodType* string

^ Period type for this period limit

Enum:
[ Day, Week, Fortnight, Month, Half-year, Year ]
PaymentFromDate* string($date-time)

^ Start date time for the respective consent subscription Journey.

PaymentToDate string($date-time)

^ End date time for the respective consent subscription Journey.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}]
VRPType* [
minItems: 1

^ The types of payments that can be made under this VRP consent. This can be used to indicate whether this include sweeping payment or other ecommerce payments.

OBVRPConsentTypestringEnum:
[ UK.OBIE.VRPType.Other ]]
VRPSubType [
minItems: 1

^ The Subtypes of payments that can be made under this VRPType consent. This can be used to indicate whether this include other or ecommerce payments.

OBVRPConsentSubTypestringEnum:
[ UK.NWG.VRPSubType.Single, UK.NWG.VRPSubType.Ongoing, UK.NWG.VRPSubType.Subscription ]]
PSUAuthenticationMethods* [
minItems: 1

^ Indicates that the PSU authentication methods supported.

OBVRPAuthenticationMethodsstring

The authentication method that was used to authenticate the PSU.

Enum:
[ UK.OBIE.SCA, UK.OBIE.SCANotRequired ]]
PSUInteractionTypes [

^ Indicates interaction type, currently if customer is present or not present.

OBVRPInteractionTypesstringEnum:
[ InSession, OffSession ]]
SupplementaryData {
description:

^ Additional information that can not be captured in the structured fields and/or any other specific block

}
}
Initiation* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInitiationOBDomesticVRPInitiation{
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
CreditorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [...]
}
RemittanceInformation {...}
}
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
Array [ 12 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress {
description:

Information that locates and identifies a specific address, as defined by postal services or in free format text.

AddressLine [
maxItems: 2
minItems: 0
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

]
StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName* TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country* CountryCodestring
example: GB

Nation with its own government.

}
}
Links* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload. At present no fields are used for VRP.

}
}
OBDomesticVRPConsentRequest{
Data* {
ReadRefundAccount string

Indicates whether information about RefundAccount should be included in the payment response.

Enum:
Array [ 2 ]
ControlParameters* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPControlParametersOBDomesticVRPControlParameters{...}
Initiation* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInitiationOBDomesticVRPInitiation{...}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
[ BillingGoodsAndServicesInAdvance, BillingGoodsAndServicesInArrears, PispPayee, EcommerceMerchantInitiatedPayment, FaceToFacePointOfSale, TransferToSelf, TransferToThirdParty, BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress {
description:

Information that locates and identifies a specific address, as defined by postal services or in free format text.

AddressLine [...]
StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName* TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country* CountryCodestring
example: GB

Nation with its own government.

}
}
}
OBDomesticVRPControlParameters{
ValidFromDateTime string($date-time)

^ Start date time for which the consent remains valid.

ValidToDateTime string($date-time)

^ End date time for which the consent remains valid.

InitialPayment https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
MaximumIndividualAmount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
MaximumCumulativeAmount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
MaximumCumulativeNumberOfPayments integer

^ The maximum number of payments that can be made over the entire life of the VRP consent

PeriodicLimits [
minItems: 1
{
PeriodType* string

^ Period type for this period limit

Enum:
[ Day, Week, Fortnight, Month, Half-year, Year ]
PeriodAlignment* string

^ Specifies whether the period starts on the date of consent creation or lines up with a calendar

Enum:
[ Consent, Calendar ]
Amount OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

NumberOfPayments integer

^ The number of payments that can be made under this consent in the period specified

}]
PeriodicPayments [
minItems: 1

This parameter is only valid for Subscription based Journey, when VRP Subtype is selected as UK.NWB.VRPSubType.subscription .

{
PeriodType* string

^ Period type for this period limit

Enum:
[ Day, Week, Fortnight, Month, Half-year, Year ]
PaymentFromDate* string($date-time)

^ Start date time for the respective consent subscription Journey.

PaymentToDate string($date-time)

^ End date time for the respective consent subscription Journey.

Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}]
VRPType* [
minItems: 1

^ The types of payments that can be made under this VRP consent. This can be used to indicate whether this include sweeping payment or other ecommerce payments.

OBVRPConsentTypestringEnum:
[ UK.OBIE.VRPType.Other ]]
VRPSubType [
minItems: 1

^ The Subtypes of payments that can be made under this VRPType consent. This can be used to indicate whether this include other or ecommerce payments.

OBVRPConsentSubTypestringEnum:
[ UK.NWG.VRPSubType.Single, UK.NWG.VRPSubType.Ongoing, UK.NWG.VRPSubType.Subscription ]]
PSUAuthenticationMethods* [
minItems: 1

^ Indicates that the PSU authentication methods supported.

OBVRPAuthenticationMethodsstring

The authentication method that was used to authenticate the PSU.

Enum:
[ UK.OBIE.SCA, UK.OBIE.SCANotRequired ]]
PSUInteractionTypes [

^ Indicates interaction type, currently if customer is present or not present.

OBVRPInteractionTypesstringEnum:
[ InSession, OffSession ]]
SupplementaryData {
description:

^ Additional information that can not be captured in the structured fields and/or any other specific block

}
}
OBDomesticVRPInitiation{
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
CreditorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
RemittanceInformation {
description:

^ Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
example: UNSTRUCTURED
minLength: 1
maxLength: 140

^ Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
pattern: [a-z0-9]{8}-[0-9]{4}-[a-z0-9]{4}
minLength: 1
maxLength: 18

^ Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage - If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

}
}
OBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
OBBranchAndFinancialInstitutionIdentification6{
SchemeName OBExternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 1 ]
Identification string
minLength: 1
maxLength: 35

^ Unique and unambiguous identification of a financial institution or a branch of a financial institution.

Name string
minLength: 1
maxLength: 140

^ Name by which an agent is known and which is usually used to identify that agent.

PostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
}
OBDomesticVRPRequest{
Data* {
ConsentId* string
minLength: 1
maxLength: 128

Identifier for the Domestic VRP Consent that this payment is made under.

PSUAuthenticationMethod* OBVRPAuthenticationMethodsstring

The authentication method that was used to authenticate the PSU.

Enum:
Array [ 2 ]
PSUInteractionType OBVRPInteractionTypesstringEnum:
Array [ 2 ]
Initiation* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInitiationOBDomesticVRPInitiation{
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
CreditorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
RemittanceInformation {
description:

^ Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
example: UNSTRUCTURED
minLength: 1
maxLength: 140

^ Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
pattern: [a-z0-9]{8}-[0-9]{4}-[a-z0-9]{4}
minLength: 1
maxLength: 18

^ Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage - If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

}
}
Instruction* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInstructionOBDomesticVRPInstruction{
InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBVRPRemittanceInformationOBVRPRemittanceInformation{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
minLength: 1
maxLength: 140

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
minLength: 1
maxLength: 18

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. The PISP must populate this with the same value as specified in the Data.Initiation.RemittanceInformation.Reference of the consent.

}
LocalInstrument OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
[ UK.OBIE.BACS, UK.OBIE.BalanceTransfer, UK.OBIE.CHAPS, UK.OBIE.Euro1, UK.OBIE.FPS, UK.OBIE.Link, UK.OBIE.MoneyTransfer, UK.OBIE.Paym, UK.OBIE.SEPACreditTransfer, UK.OBIE.SEPAInstantCreditTransfer, UK.OBIE.SWIFT, UK.OBIE.Target2 ]
InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [...]
}
CreditorAccount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
SupplementaryData {
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
Array [ 12 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress {
description:

Information that locates and identifies a specific address, as defined by postal services or in free format text.

AddressLine [
maxItems: 2
minItems: 0
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

]
StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName* TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country* CountryCodestring
example: GB

Nation with its own government.

}
}
}
OBDomesticVRPResponse{
Data* {
DomesticVRPId* string
minLength: 1
maxLength: 40

Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.

ConsentId* string
minLength: 1
maxLength: 128

Identifier for the Domestic VRP Consent that this payment is made under.

CreationDateTime* string($date-time)

Date and time at which the resource was created.

Status* string

Specifies the status of the payment information group.

Enum:
[ AcceptedCreditSettlementCompleted, AcceptedWithoutPosting, AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected ]
StatusReason OBVRPStatusReasonCodestring

Reason Code provided for the status of a VRP. To be documented in the Developer Portal.

Enum:
[ UK.OBIE.ExemptionNotApplied, UK.OBIE.OtherReason ]
StatusReasonDescription string
minLength: 1
maxLength: 256

Description related to provided Status/StatusReason

StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated.

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource.

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource.

Refund https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
Charges [{
description:

Set of elements used to provide details of a charge for the payment initiation.

ChargeBearer* OBChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
Type* OBExternalPaymentChargeType1CodestringEnum:
[ UK.OBIE.CHAPSOut, UK.OBIE.BalanceTransferOut, UK.OBIE.MoneyTransferOut ]
Amount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}]
Initiation* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInitiationOBDomesticVRPInitiation{
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
CreditorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
RemittanceInformation {
description:

^ Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
example: UNSTRUCTURED
minLength: 1
maxLength: 140

^ Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
pattern: [a-z0-9]{8}-[0-9]{4}-[a-z0-9]{4}
minLength: 1
maxLength: 18

^ Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage - If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.

}
}
Instruction* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInstructionOBDomesticVRPInstruction{
InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBVRPRemittanceInformationOBVRPRemittanceInformation{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
minLength: 1
maxLength: 140

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
minLength: 1
maxLength: 18

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. The PISP must populate this with the same value as specified in the Data.Initiation.RemittanceInformation.Reference of the consent.

}
LocalInstrument OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
Array [ 12 ]
InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [...]
}
CreditorAccount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
SupplementaryData {
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
Array [ 12 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress {
description:

Information that locates and identifies a specific address, as defined by postal services or in free format text.

AddressLine [
maxItems: 2
minItems: 0
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

]
StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName* TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country* CountryCodestring
example: GB

Nation with its own government.

}
}
Links* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload. At present no fields are used for VRP.

}
}
OBDomesticVRPResponseNonSweepingSingle{
Data* {
DomesticVRPId* string
minLength: 1
maxLength: 40

Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.

ConsentId* string
minLength: 1
maxLength: 128

Identifier for the Domestic VRP Consent that this payment is made under.

CreationDateTime* string($date-time)

Date and time at which the resource was created.

Status* string

Specifies the status of the payment information group.

Enum:
[ AcceptedCreditSettlementCompleted, AcceptedWithoutPosting, AcceptedSettlementCompleted, AcceptedSettlementInProcess, Pending, Rejected ]
StatusReason OBVRPStatusReasonCodestring

Reason Code provided for the status of a VRP. To be documented in the Developer Portal.

Enum:
[ UK.OBIE.ExemptionNotApplied, UK.OBIE.OtherReason ]
StatusReasonDescription string
minLength: 1
maxLength: 256

Description related to provided Status/StatusReason

StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated.

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource.

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource.

Refund https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{...}
Charges [...]
Initiation* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInitiationOBDomesticVRPInitiation{
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
CreditorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
RemittanceInformation {...}
}
Instruction* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInstructionOBDomesticVRPInstruction{
InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBVRPRemittanceInformationOBVRPRemittanceInformation{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
minLength: 1
maxLength: 140

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
minLength: 1
maxLength: 18

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. The PISP must populate this with the same value as specified in the Data.Initiation.RemittanceInformation.Reference of the consent.

}
LocalInstrument OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
[ UK.OBIE.BACS, UK.OBIE.BalanceTransfer, UK.OBIE.CHAPS, UK.OBIE.Euro1, UK.OBIE.FPS, UK.OBIE.Link, UK.OBIE.MoneyTransfer, UK.OBIE.Paym, UK.OBIE.SEPACreditTransfer, UK.OBIE.SEPAInstantCreditTransfer, UK.OBIE.SWIFT, UK.OBIE.Target2 ]
InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
CreditorAccount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
SupplementaryData {
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
Array [ 12 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress {
description:

Information that locates and identifies a specific address, as defined by postal services or in free format text.

AddressLine [
maxItems: 2
minItems: 0
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

]
StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName* TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country* CountryCodestring
example: GB

Nation with its own government.

}
}
Links* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload. At present no fields are used for VRP.

}
}
OBDomesticVRPResponseNonSweepingOngoing{
Data* {
DomesticVRPId* string
minLength: 1
maxLength: 40

Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.

ConsentId* string
minLength: 1
maxLength: 128

Identifier for the Domestic VRP Consent that this payment is made under.

CreationDateTime* string($date-time)

Date and time at which the resource was created.

Status* string

Specifies the status of the payment information group.

Enum:
Array [ 6 ]
StatusReason OBVRPStatusReasonCodestring

Reason Code provided for the status of a VRP. To be documented in the Developer Portal.

Enum:
Array [ 2 ]
StatusReasonDescription string
minLength: 1
maxLength: 256

Description related to provided Status/StatusReason

StatusUpdateDateTime* string($date-time)

Date and time at which the resource status was updated.

ExpectedExecutionDateTime string($date-time)

Expected execution date and time for the payment resource.

ExpectedSettlementDateTime string($date-time)

Expected settlement date and time for the payment resource.

Refund https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
Charges [...]
Initiation* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInitiationOBDomesticVRPInitiation{
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
CreditorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{...}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [...]
}
RemittanceInformation {...}
}
Instruction* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBDomesticVRPInstructionOBDomesticVRPInstruction{
InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBVRPRemittanceInformationOBVRPRemittanceInformation{...}
LocalInstrument OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
Array [ 12 ]
InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{...}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{...}
CreditorAccount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{...}
SupplementaryData {...}
}
DebtorAccount https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountDebtorWithNameOBCashAccountDebtorWithName{
description:

The value must be populated for GET responses once the consent is approved (DebtorAccount). Only included in the response if Data.ReadRefundAccount is set to Yes in the consent (Refund).

SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
Array [ 5 ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

^ Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
example: ACE Ltd
minLength: 1
maxLength: 350

^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

}
}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
Array [ 12 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress {...}
}
Links* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload. At present no fields are used for VRP.

}
}
OBDomesticVRPResponseNonSweepingSubscription{
Data* {...}
Risk* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBRisk1OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
Array [ 12 ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
Array [ 15 ]
DeliveryAddress {...}
}
Links* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/LinksLinks{
description:

Links relevant to the payload

Self* string($uri)
First string($uri)
Prev string($uri)
Next string($uri)
Last string($uri)
}
Meta* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/MetaMetaData{
description:

Meta Data relevant to the payload. At present no fields are used for VRP.

}
}
OBDomesticVRPDetails{
Data {
PaymentStatus [{
PaymentTransactionId* string
minLength: 1
maxLength: 210

Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable.

Status* string

Status of a transfer, as assigned by the transaction administrator.

Enum:
[ Accepted, AcceptedCancellationRequest, AcceptedCreditSettlementCompleted, AcceptedCustomerProfile, AcceptedFundsChecked, AcceptedSettlementCompleted, AcceptedSettlementInProcess, AcceptedTechnicalValidation, AcceptedWithChange, AcceptedWithoutPosting, Cancelled, NoCancellationProcess, PartiallyAcceptedCancellationRequest, PartiallyAcceptedTechnicalCorrect, PaymentCancelled, Pending, PendingCancellationRequest, Received, Rejected, RejectedCancellationRequest ]
StatusUpdateDateTime* string($date-time)

Date and time at which the status was assigned to the transfer.

StatusDetail {
LocalInstrument OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
[ UK.OBIE.BACS, UK.OBIE.BalanceTransfer, UK.OBIE.CHAPS, UK.OBIE.Euro1, UK.OBIE.FPS, UK.OBIE.Link, UK.OBIE.MoneyTransfer, UK.OBIE.Paym, UK.OBIE.SEPACreditTransfer, UK.OBIE.SEPAInstantCreditTransfer, UK.OBIE.SWIFT, UK.OBIE.Target2 ]
Status* string
minLength: 1
maxLength: 128

Status of a transfer, as assigned by the transaction administrator.

StatusReason string

Reason Code provided for the status of a transfer.

Enum:
[ Cancelled, PendingFailingSettlement, PendingSettlement, Proprietary, ProprietaryRejection, Suspended, Unmatched ]
StatusReasonDescription string
minLength: 1
maxLength: 128

Reason provided for the status of a transfer.

}
}]
}
}
OBVRPFundsConfirmationRequest{
description:

The OBVRPFundsConfirmationRequest object must be used to request funds availability for a specific amount in the Debtor Account included in the VRP consents.

Data* {
ConsentId* string
minLength: 1
maxLength: 128

Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.

Reference string
minLength: 1
maxLength: 35

Unique reference, as assigned by the PISP, to unambiguously refer to the request related to the payment transaction.

InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}
}
OBVRPFundsConfirmationResponse{
description:

The confirmation of funds response contains the result of a funds availability check.

Data* {
FundsConfirmationId* string
minLength: 1
maxLength: 40

Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation resource.

ConsentId* string
minLength: 1
maxLength: 128

Unique identification as assigned by the ASPSP to uniquely identify the funds confirmation consent resource.

CreationDateTime* string($date-time)

Date and time at which the resource was created.

Reference string
minLength: 1
maxLength: 35

Unique reference, as assigned by the CBPII, to unambiguously refer to the request related to the payment transaction.

FundsAvailableResult* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPAFundsAvailableResult1OBPAFundsAvailableResult1{
description:

Availability result, clearly indicating the availability of funds given the Amount in the request.

FundsAvailableDateTime* string($date-time)

Date and time at which the funds availability check was generated.

FundsAvailable* string

Availability result, clearly indicating the availability of funds given the Amount in the request.

Enum:
[ Available, NotAvailable ]
}
InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
}
}
OBPAFundsAvailableResult1{
description:

Availability result, clearly indicating the availability of funds given the Amount in the request.

FundsAvailableDateTime* string($date-time)

Date and time at which the funds availability check was generated.

FundsAvailable* string

Availability result, clearly indicating the availability of funds given the Amount in the request.

Enum:
[ Available, NotAvailable ]
}
OBCharge2{
ChargeBearer* OBChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
}
OBExternalStatus2CodestringEnum:
[ Authorised, Revoked, AwaitingAuthorisation, Rejected ]
OBChargeBearerType1Codestring

Specifies which party/parties will bear the charges associated with the processing of the payment transaction.

Enum:
[ BorneByCreditor, BorneByDebtor, FollowingServiceLevel, Shared ]
OBDomesticVRPInstruction{
InstructionIdentification* string
minLength: 1
maxLength: 35

Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

EndToEndIdentification* string
minLength: 1
maxLength: 35

Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field

RemittanceInformation https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBVRPRemittanceInformationOBVRPRemittanceInformation{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
minLength: 1
maxLength: 140

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
minLength: 1
maxLength: 18

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. The PISP must populate this with the same value as specified in the Data.Initiation.RemittanceInformation.Reference of the consent.

}
LocalInstrument OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
Array [ 12 ]
InstructedAmount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBActiveOrHistoricCurrencyAndAmountOBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
CreditorPostalAddress https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBPostalAddress6OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
Array [ 8 ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
CreditorAccount* https://api.sandbox.natwest.com/devportal/upload/file/4162699?jwt=eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJtaDlDNF90bC1yNVdCRFdNRGNQT0JkUXF5T001NWs1QmJ5cWRJLWJxcXZRIn0.eyJleHAiOjE3NTAxNDY2ODQsImlhdCI6MTc1MDE0NjM4NCwiYXV0aF90aW1lIjoxNzUwMTQyNTU5LCJqdGkiOiIxMmNiYTllOS02MTg0LTQ0ZWItYWUyZi0xNDcyM2QxYjlmODkiLCJpc3MiOiJodHRwczovL2F1dGguc2FuZGJveC5uYXR3ZXN0LmNvbS9hdXRoL3JlYWxtcy9OYXRXZXN0UG9ydGFsIiwiYXVkIjoiYWNjb3VudCIsInN1YiI6ImJmYjBmZmQ2LTRhMWEtNDU2Yy1hYmQzLWUyNDZmNzNmYWIyNyIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldnBvcnRhbCIsIm5vbmNlIjoiNjZiMTRhOWMtMmJlYS00MjFiLTg2NTgtMzljZTdjMjcxZWUzIiwic2Vzc2lvbl9zdGF0ZSI6ImEyOTNhNjgzLTA5ODAtNDhjOC04M2VjLTE4ZTlkZGIwZTYzMiIsImFjciI6IjAiLCJhbGxvd2VkLW9yaWdpbnMiOlsiaHR0cHM6Ly9kZXZlbG9wZXIuc2FuZGJveC5uYXR3ZXN0LmNvbSJdLCJyZWFsbV9hY2Nlc3MiOnsicm9sZXMiOlsib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIiwibmFtZSI6IkF6YW0gQWx0YWYiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJtdWhhbW1hZGF6YW0uYWx0YWZAY29uc3VsdGFuY3lvdXRmaXQuY28udWsiLCJnaXZlbl9uYW1lIjoiQXphbSIsImZhbWlseV9uYW1lIjoiQWx0YWYiLCJlbWFpbCI6Im11aGFtbWFkYXphbS5hbHRhZkBjb25zdWx0YW5jeW91dGZpdC5jby51ayJ9.D8zDQVU418-zbsaj0EGKEyV7LvUiH46I7lvoYKanWIJ4zFmmf0baZaIgARU4jFWbr_BMDs1sv23_tXLgMJjWs3dt5TQMgtoWSrSn0tswPge5QVN5huN4nXsmgICAMN663TJ8FjDmJMmwPG-V4M8VsDL_ISz8D70KeMcHwwpAYMsz8290F-Uez799RhgbucnddLgDt3cZ_xnjR3EniRWE6ryNd-uUprxHjJBmVBJhm_yk_FmqO8z66K9yXFXlBj0rekd4K4yzsZ4HnVcR6MYFhPVXkp9cL9Tlyzjp7I8bDJ6gMOU9XyIPqPDp2rt_DapmCis0ovnxgogGG1dukoCxcA#/components/schemas/OBCashAccountCreditor3OBCashAccountCreditor3{
SchemeName* OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
Identification* string
pattern: \d{14}
minLength: 1
maxLength: 256

Identification assigned by an institution to identify an account. This identification is known by the account owner.

Name* string
minLength: 1
maxLength: 350

Name of the account, as assigned by the account servicing institution. Usage: the account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.

SecondaryIdentification string
example: secondary-identif
minLength: 1
maxLength: 34

This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)

MerchantName string
example: ACME Ltd
minLength: 1
maxLength: 100

This is the everyday business name that the end customer interacts with. This may be different to the registered company name. This information is to be used to identify the end recipient of the payments to the customer and will allow for reconciliation to be performed easily.

}
SupplementaryData {
description:

Additional information that can not be captured in the structured fields and/or any other specific block.

}
}
OBVRPRemittanceInformation{
description:

Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.

Unstructured string
minLength: 1
maxLength: 140

Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.

Reference string
minLength: 1
maxLength: 18

Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. The PISP must populate this with the same value as specified in the Data.Initiation.RemittanceInformation.Reference of the consent.

}
OBExternalAccountIdentification4Codestring
example: UK.OBIE.SortCodeAccountNumber

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BBAN, UK.OBIE.IBAN, UK.OBIE.PAN, UK.OBIE.Paym, UK.OBIE.SortCodeAccountNumber ]
OBExternalFinancialInstitutionIdentification4Codestring

Name of the identification scheme, in a coded form as published in an external list.

Enum:
[ UK.OBIE.BICFI ]
OBExternalAccountType1Codestring

Specifies the type of account (personal or business).

Enum:
[ Business, Personal ]
OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
OBExternalLocalInstrument1Codestring

User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.

Enum:
[ UK.OBIE.BACS, UK.OBIE.BalanceTransfer, UK.OBIE.CHAPS, UK.OBIE.Euro1, UK.OBIE.FPS, UK.OBIE.Link, UK.OBIE.MoneyTransfer, UK.OBIE.Paym, UK.OBIE.SEPACreditTransfer, UK.OBIE.SEPAInstantCreditTransfer, UK.OBIE.SWIFT, UK.OBIE.Target2 ]
OBActiveOrHistoricCurrencyAndAmount{
Amount* OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

Currency* ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

}
ActiveOrHistoricCurrencyCodestring
minLength: 3
maxLength: 3
example: GBP

A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

OBActiveCurrencyAndAmount_SimpleTypestring
pattern: ^\d{1,13}$|^\d{1,13}\.\d{2}$

A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.

OBExternalPaymentChargeType1CodestringEnum:
[ UK.OBIE.CHAPSOut, UK.OBIE.BalanceTransferOut, UK.OBIE.MoneyTransferOut ]
OBPostalAddress6{
description:

Information that locates and identifies a specific address, as defined by postal services.

AddressType OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Department Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartment SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country CountryCodestring
example: GB

Nation with its own government.

AddressLine [
minItems: 0
maxItems: 7
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, presented in free format text.

]
}
OBAddressTypeCodestring

Identifies the nature of the postal address.

Enum:
[ Business, Correspondence, DeliveryTo, MailTo, POBox, Postal, Residential, Statement ]
Departmentstring
minLength: 1
maxLength: 70

Identification of a division of a large organisation or building.

SubDepartmentstring
minLength: 1
maxLength: 70

Identification of a sub-division of a large organisation or building.

StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

CountryCodestring
example: GB

Nation with its own government.
OBVRPStatusReasonCodestring

Reason Code provided for the status of a VRP. To be documented in the Developer Portal.

Enum:
[ UK.OBIE.ExemptionNotApplied, UK.OBIE.OtherReason ]
OBVRPConsentTypestringEnum:
[ UK.OBIE.VRPType.Other ]
OBVRPConsentSubTypestringEnum:
[ UK.NWG.VRPSubType.Single, UK.NWG.VRPSubType.Ongoing, UK.NWG.VRPSubType.Subscription ]
OBVRPAuthenticationMethodsstring

The authentication method that was used to authenticate the PSU.

Enum:
[ UK.OBIE.SCA, UK.OBIE.SCANotRequired ]
OBVRPInteractionTypesstringEnum:
[ InSession, OffSession ]
OBRisk1{
description:

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.

PaymentContextCode string

Specifies the payment context

  • BillPayment - @deprecated
  • EcommerceGoods - @deprecated
  • EcommerceServices - @deprecated
  • Other - @deprecated
  • PartyToParty - @deprecated
Enum:
[ BillingGoodsAndServicesInAdvance, BillingGoodsAndServicesInArrears, PispPayee, EcommerceMerchantInitiatedPayment, FaceToFacePointOfSale, TransferToSelf, TransferToThirdParty, BillPayment, EcommerceGoods, EcommerceServices, Other, PartyToParty ]
MerchantCategoryCode string
minLength: 3
maxLength: 4

Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction.

MerchantCustomerIdentification string
minLength: 1
maxLength: 70

The unique customer identifier of the PSU with the merchant.

ContractPresentInidicator boolean

Indicates if Payee has a contractual relationship with the PISP.

BeneficiaryPrepopulatedIndicator boolean

Indicates if PISP has immutably prepopulated payment details in for the PSU.

PaymentPurposeCode string
minLength: 3
maxLength: 4

Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List

BeneficiaryAccountType OBExternalExtendedAccountType1Codestring

Specifies the extended type of account.

Enum:
[ Business, BusinessSavingsAccount, Charity, Collection, Corporate, Ewallet, Government, Investment, ISA, JointPersonal, Pension, Personal, PersonalSavingsAccount, Premier, Wealth ]
DeliveryAddress {
description:

Information that locates and identifies a specific address, as defined by postal services or in free format text.

AddressLine [
maxItems: 2
minItems: 0
string
minLength: 1
maxLength: 70

Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.

]
StreetName StreetNamestring
minLength: 1
maxLength: 70

Name of a street or thoroughfare.

BuildingNumber BuildingNumberstring
minLength: 1
maxLength: 16

Number that identifies the position of a building on a street.

PostCode PostCodestring
minLength: 1
maxLength: 16

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

TownName* TownNamestring
minLength: 1
maxLength: 35

Name of a built-up area, with defined boundaries, and a local government.

CountrySubDivision CountrySubDivisionstring
minLength: 1
maxLength: 35

Identifies a subdivision of a country such as state, region, county.

Country* CountryCodestring
example: GB

Nation with its own government.

}
}
MetaData{
description:

Meta Data relevant to the payload. At present no fields are used for VRP.

}
OBErrorCodestring

enum of the namespaced enum so its created in code generation

Enum:
[ UK.OBIE.Field.Expected, UK.OBIE.Field.Invalid, UK.OBIE.Field.InvalidDate, UK.OBIE.Field.Missing, UK.OBIE.Field.Unexpected, UK.OBIE.Header.Invalid, UK.OBIE.Header.Missing, UK.OBIE.Reauthenticate, UK.OBIE.Resource.ConsentMismatch, UK.OBIE.Resource.InvalidConsentStatus, UK.OBIE.Resource.InvalidFormat, UK.OBIE.Resource.NotFound, UK.OBIE.Rules.AfterCutOffDateTime, UK.OBIE.Rules.DuplicateReference, UK.OBIE.Rules.FailsControlParameters, UK.OBIE.Signature.Invalid, UK.OBIE.Signature.InvalidClaim, UK.OBIE.Signature.Malformed, UK.OBIE.Signature.Missing, UK.OBIE.Signature.MissingClaim, UK.OBIE.Signature.Unexpected, UK.OBIE.UnexpectedError, UK.OBIE.Unsupported.AccountIdentifier, UK.OBIE.Unsupported.AccountSecondaryIdentifier, UK.OBIE.Unsupported.Currency, UK.OBIE.Unsupported.Frequency, UK.OBIE.Unsupported.LocalInstrument, UK.OBIE.Unsupported.Scheme, UK.OBIE.Rules.ResourceAlreadyExists ]
Powered by Oolys
Your session is about to expire
You will be automatically logged out in 59 seconds.
Do you want to extend your session?